home *** CD-ROM | disk | FTP | other *** search
/ Mac Magazin/MacEasy 24 / Mac Magazin and MacEasy Magazine CD - Issue 24.iso / Grafik & Text / DropFormatter1.2 / ReadMe < prev    next >
Text File  |  1996-06-28  |  7KB  |  57 lines

  1. <title>Drop Formatter version 1.1</title>
  2. <small>Contents:
  3.     <a href="#description">About Drop Formatter</a>
  4.     <a href="#contact">Contact & Payment Info</a>
  5.     <a href="#new1.1">What's new in version 1.1</a>
  6.     <a href="#upcoming">What's Coming</small></a>
  7.  
  8. <a name="description">Drop Formatter is a desktop drag & drop application. Place an alias of it on your desktop and you may drag TEXT files onto it. From these text files, Drop Formatter will generate formatted HTML files and text files.
  9.  
  10. One of the annoying things about publishing on the Web is most of the process is repetitive and breath-takingly dull. It seems nearly all of my pages use the same layout. Certainly all of my text is formatted in much the same way for each page. Why can't I then, write what I want in a text editor, say BBEdit, and have a program format the text so it looks good?
  11.     I don't want to give up the ability to custom format text, like <i>italicising</i> or <b>bold-facing</b>, but I want the computer to do most of the grunt work for me. After all, isn't that what computers are good at? Repetitive, boring jobs.
  12. I thought so...
  13.  
  14. <big>HTML Formatting</big>
  15.  
  16. The source files are essentially HTML files with quite a bit of the extra bits left off. As a result, you can put any valid HTML tags into a source file. Define a link by adding an anchor or style text by adding italics or bold-face.
  17.     Drop Formatter reads the text file dropped on it and breaks it into paragraphs. If a line ends with a standard sentence ending punctuation mark ( . ? ! or : ) the paragraph is closed.
  18.     Between paragraphs, Drop Formatter inserts a small verticle space. Not quite as much as <br> but about 5 pixels. This vertical space is customisable via the preferences dialog box.
  19.     Indented paragraphs are indented roughly 20 pixels by inserting a clear inline GIF file. After a series of indented paragraphs and before the next non-indented paragraph, an additional vertical space is added.
  20.     For the most part, the actual text of the file is left untouched. One exception is the dash character. When Drop Formatter encounters a dash character between two alphabetic characters, it inserts the optional word-break tag following the dash. This isn't quite as good as optional hyphenation (a feature sorely lacking in both Netscape and Microsoft's products) but it is quite a bit better than adding <wbr> by hand.
  21.     You might think the header file determines the title of the document; but, if the source file has a title block, the text of the title block will replace the title specified in the header file. The text of the title block will be formatted using the big tag in the actual body.
  22.  
  23. <big>Text Formatting</big>
  24.  
  25. Drop Formatter can also generate a plain text version of the source file dropped on it. All HTML tags are stripped from the source file. Some of the HTML tags are interpretted and affect the resultant text.
  26.     The italic tag quotes the text it encapsulates. This is how I work, so it is how Drop Formatter works. I might place this sort of behavior in a preference if there is enough interest. Basically, I italicise things which were italics not available I would quote. Because plain text has no italics, where italics are requested the text is quoted. I would have done something with bold and underline, but I couldn't come up with anything.
  27.     Please note, I mean italics as represented by the tag <i> not emphasis as represented by <em>. This gives you a way to specify italics which should <em>not</em> be quoted. I use this difference a lot.
  28.  
  29. <big>Headers & Footers</big>
  30.  
  31. When formatting HTML output, Drop Formatter looks for header and footer files in the same folder as the source file. You may have header and footer files that are specific to individual files or generic to all files.
  32.     File specific headers and footers should have the form <code>BaseFile.header.html</code> and <code>BaseFile.footer.html</code>. Generic headers and footers should be named <code>header.html</code> and <code>footer.html</code>.
  33.     If neither file-specific nor generic header & footer can be found in the same directory as the source file, Drop Formatter looks for the files <code>header.html</code> and <code>footer.html</code> in its directory. These default files better exist or Drop Formatter will refuse to format your HTML.
  34.  
  35. <a name="contact"><big>Contact & Payment Info</big></a>
  36.  
  37. If you have any comments or suggestions for enhancements, please, contact me by mail at <a href="mailto:jwatkins@futurepress.com">jwatkins@futurepress.com</a>. I don't want this tool to become huge and bloated but there are probably a half dozen things I might add to make it a bit cooler and more useful.
  38.     As far as paying for Drop Formatter goes, don't bother. I use a lot of shareware and freeware tools while creating web-sites and software. I'm happy to give back a little of what I've gotten. But if you feel you really have to send me some money, I won't complain.
  39.  
  40. <big>What's New</big>
  41.  
  42. <a name="new1.1">Version 1.1</a>
  43.  
  44. Hah! Well, in addition to adding a 68K version, which I simply forgot in version 1.0, I've subtly changed how paragraphs are spaced. The space between un-indented paragraphs is no longer the same as the InterSection space, it is now twice the InterParagraph space. As a result, headers bind a bit closer to the paragraph they head.
  45.     I've also tuned the code to handle HTML quoted entities while generating text files. If you have the string &amp; in your file (to generate an ampersand) you will get an ampersand in your text file. Made pretty good sense, I thought.
  46.     You may now, via the preferences dialog, specify whether the title should be rendered in a larger or smaller font. Some of my pages are titled by the creation date. I wanted the date smaller and in the top right corner of the page. I can now do that. Only, I've got to change the preference setting each time.
  47.  
  48. <a name="upcoming"><big>What's Coming</big></a>
  49.  
  50. Style Sheets
  51.  
  52. At the moment, I'm not certain how I'll do this, but I know I want to. Ideally, any option you might specify via the preference dialog box could be specified by placing an option in the Header file.
  53.     Another thought I had was to create another set of files named "style". You could have a default style sheet in the same folder as the application as well as a generic style sheet in the same folder as the document. You might even have a document specific style sheet. This would undoubtably give you the most configurable settings.
  54.     Unlike the header and footer, style sheets should be cumulative. The app ought to read the default style sheet first (in the application's folder), then the style sheet in the same directory as the document, and finally the style sheet for the document.
  55.     You should expect style sheets to appear in the next release.
  56.     
  57.